package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.AttendShiftStaffScheduleAddDTO;
import org.jsola.hr.dto.AttendShiftStaffScheduleUpdateDTO;
import org.jsola.hr.query.AttendShiftStaffScheduleQuery;
import org.jsola.hr.vo.AttendShiftStaffScheduleListVO;
import org.jsola.hr.vo.AttendShiftStaffScheduleVO;

import java.util.List;

/**
 * @author zhr
 */
@Api(tags = "hr-考勤人员排班表")
public interface IAttendShiftStaffScheduleControllerAPI {

    /**
     * 新增考勤人员排班表
     * @param attendShiftStaffScheduleAddDTO 考勤人员排班表新增实体
     * @return 考勤人员排班表展示对象
     */
    @ApiOperation(value = "新增考勤人员排班表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendShiftStaffScheduleAddDTO", dataType = "AttendShiftStaffScheduleAddDTO", value = "新增考勤人员排班表", paramType = "body")
    })
    Result<AttendShiftStaffScheduleVO> save(AttendShiftStaffScheduleAddDTO attendShiftStaffScheduleAddDTO);


    /**
     * 修改考勤人员排班表
     * @param attendShiftStaffScheduleUpdateDTO 考勤人员排班表
     * @return 更新数量
     */
    @ApiOperation(value = "修改考勤人员排班表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendShiftStaffScheduleUpdateDTO", dataType = "AttendShiftStaffScheduleUpdateDTO", value = "修改考勤人员排班表", paramType = "body")
    })
    Result<Integer> update(AttendShiftStaffScheduleUpdateDTO attendShiftStaffScheduleUpdateDTO);




    /**
     * 删除单个考勤人员排班表，彻底删除
     * @param attendShiftStaffScheduleId 考勤人员排班表id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个考勤人员排班表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendShiftStaffScheduleId", dataType = "String", value = "考勤人员排班表id", paramType = "path")
    })
    Result<Integer> delete(String attendShiftStaffScheduleId);


    /**
     * 批量删除考勤人员排班表，彻底删除
     * @param attendShiftStaffScheduleIds 考勤人员排班表id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除考勤人员排班表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendShiftStaffScheduleIds", dataType = "String[]", value = "考勤人员排班表id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] attendShiftStaffScheduleIds);


    /**
     * 根据考勤人员排班表id查询考勤人员排班表详情
     * @param attendShiftStaffScheduleId 考勤人员排班表id
     * @return 考勤人员排班表详情
     */
    @ApiOperation(value="根据考勤人员排班表id查询考勤人员排班表详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendShiftStaffScheduleId", dataType = "String", value = "考勤人员排班表id", paramType = "path")
    })
    Result<AttendShiftStaffScheduleVO> findById(String attendShiftStaffScheduleId);


    /**
     * 查询考勤人员排班表
     * @param attendShiftStaffScheduleQuery 考勤人员排班表查询参数
     * @return page
     */
    @ApiOperation(value="查询考勤人员排班表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendShiftStaffScheduleQuery", dataType = "AttendShiftStaffScheduleQuery", value = "考勤人员排班表查询参数", paramType = "query")
    })
    Result<List<AttendShiftStaffScheduleListVO>> listAll(AttendShiftStaffScheduleQuery attendShiftStaffScheduleQuery);


     /**
     * 分页查询考勤人员排班表
     * @param attendShiftStaffScheduleQuery 考勤人员排班表查询参数
     * @return page
     */
    @ApiOperation(value="分页查询考勤人员排班表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "attendShiftStaffScheduleQuery", dataType = "AttendShiftStaffScheduleQuery", value = "考勤人员排班表查询参数", paramType = "query")
    })
    Result<Page<AttendShiftStaffScheduleListVO>> page(AttendShiftStaffScheduleQuery attendShiftStaffScheduleQuery);


}

